Vcenter Ovf ExtraConfigParams

The Vcenter Ovf ExtraConfigParams schema contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy and POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter.

JSON Example

{
    "extra_configs": [
        {
            "key": "string",
            "value": "string",
            "virtual_system_id": "string"
        }
    ],
    "exclude_keys": [
        "string"
    ],
    "include_keys": [
        "string"
    ],
    "type": "string"
}

array of Vcenter Ovf ExtraConfig

extra_configs

Optional

List of vmw:ExtraConfig elements in the OVF package.

This property is optional in the input parameters when deploying an OVF package. If missing or null there are no extra configuration elements to use for this OVF package deployment. This property will always be present in the result when retrieving information about an OVF package. It will be an empty list if there are no extra configuration elements in the OVF package.

array of string

exclude_keys

Optional

Specifies which extra configuration items in the list in the extra_configs field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the Vcenter Ovf ExtraConfig.key property.

This property is optional in the input parameters when deploying an OVF package. It is an error to set both this and Vcenter Ovf ExtraConfigParams.include_keys. This property is optional in the result when retrieving information about an OVF package. It is an error to set both this and Vcenter Ovf ExtraConfigParams.include_keys.

array of string

include_keys

Optional

Specifies which extra configuration items in the list in the extra_configs field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the Vcenter Ovf ExtraConfig.key property.

This property is optional in the input parameters when deploying an OVF package. It is an error to set both this and Vcenter Ovf ExtraConfigParams.exclude_keys. This property is optional in the result when retrieving information about an OVF package. It is an error to set both this and Vcenter Ovf ExtraConfigParams.exclude_keys.

string

type

Optional

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters schema.

This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.